Ghe integration #21929

cbehera-newrelic · 2025-10-16T09:29:18Z

No description provided.

github-actions · 2025-10-16T09:29:27Z

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local.

If you really require a preview url, reach out to one of the writers and they will generate one for you.

cbehera-newrelic · 2025-10-16T09:31:14Z

netlify build

cbehera-newrelic · 2025-10-16T13:10:48Z

netlify build

github-actions · 2025-10-16T13:10:59Z

🚀 Netlify Preview Building!

If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes):

https://ghe-integration--docs-website-netlify.netlify.app

vpayyapilly · 2025-10-21T03:31:57Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+**Prerequisites**
+
+* Login to your GitHub Enterprise account you plan to integrate with New Relic.


Suggested change

* Login to your GitHub Enterprise account you plan to integrate with New Relic.

* Login to the GitHub Enterprise account you plan to integrate with New Relic.

vpayyapilly · 2025-10-21T03:35:57Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+**Prerequisites**
+
+* Login to your GitHub Enterprise account you plan to integrate with New Relic.


How is signing in a prerequisite?

vpayyapilly · 2025-10-21T03:43:44Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+* Docker environment to run the collector service within your GHE network.
+
+
+**Architecture overview**


Would it be better to show this as a diagram?

vpayyapilly

Fix and resubmit

vpayyapilly · 2025-10-21T03:47:01Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+1. **Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.
+
+    1. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided.


Provided? Wont it be on the Docs site? Why cant we link to it?

vpayyapilly · 2025-10-21T03:48:47Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+1. **Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.
+
+    1. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided.
+    2. **Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication.


where will they find it?

vpayyapilly · 2025-10-21T03:52:54Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+        <tr>
+          <td>`API_KEY`</td>
+          <td>New Relic</td>
+          <td>Generate an API key from the New Relic dashboard.</td>


Wouldnt it be better to have deep links here?

vpayyapilly · 2025-10-21T03:55:07Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+    We will provide a sample Docker Compose file that automates the download and deployment of the service.
+
+    1. Download the provided Docker Compose file.
+    2. Configure the environment variables from step 2.


Which step 2?

vpayyapilly · 2025-10-21T03:55:32Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+    **Option B: Direct Docker image run**
+
+    You can download the Docker image directly from our Docker App registry and run it using your organization's preferred CI/CD pipeline or deployment method.


Link to Docker app library?

vpayyapilly · 2025-10-21T03:56:04Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+4. **Access the New Relic UI**: 
+
+    1. Once the collector service is running and the GitHub App is installed on your GHE organization(s), the corresponding GHE organizations will appear in the New Relic UI.
+    2. Click **First time sync** to start the initial data synchronization.


vpayyapilly · 2025-10-21T03:57:10Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+5. On the **GitHub Enterprise integration** screen:
+
+    - Click **Go to Teams** to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).


Go through all your instructions and align them to , , format

github-actions · 2025-10-28T11:33:59Z

Warning

An image has been added to src/images/.

Image files must be in static/images/. Guide to using images in docs-website

cbehera-newrelic · 2025-10-30T16:56:11Z

netlify build

cbehera-newrelic · 2025-10-30T17:02:01Z

netlify build

cbehera-newrelic · 2025-10-30T19:29:51Z

netlify build

cbehera-newrelic · 2025-10-30T20:29:56Z

netlify build

cbehera-newrelic · 2025-11-03T16:05:40Z

netlify build

vpayyapilly · 2025-11-05T05:04:27Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+* `workflow_job`
+
+<Callout variant="tip">
+**Security best practice**: Only enable the minimum permissions required for your integration needs. This reduces security exposure and follows the principle of least privilege access.


Suggested change

**Security best practice**: Only enable the minimum permissions required for your integration needs. This reduces security exposure and follows the principle of least privilege access.

**Security best practice**: To reduce security exposure, follow the principle of least privilege access and only enable the minimum permissions required for your integration needs.

vpayyapilly · 2025-11-05T05:06:10Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+### Generate and convert keys
+
+1. Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.


Suggested change

1. Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.

1. Upon creation, the app generates a unique App ID and a Private Key file (.pem format). Save these securely as you need them for the collector service configuration.

vpayyapilly · 2025-11-05T05:11:08Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+1. Navigate to your GitHub Enterprise instance.
+2. Go to **Settings** → **Developer Settings** → **GitHub Apps**.
+3. Find the GitHub App you created in step 1 and click on it.


Click the Github App you created in step 1.
Should "click" here be "select"?

vpayyapilly · 2025-11-05T05:11:40Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+1. Navigate to your GitHub Enterprise instance.
+2. Go to **Settings** → **Developer Settings** → **GitHub Apps**.
+3. Find the GitHub App you created in step 1 and click on it.
+4. Click **Install App** in the left sidebar.


Suggested change

4. Click **Install App** in the left sidebar.

4. In the left sidebar, click **Install App**.

vpayyapilly · 2025-11-05T05:13:16Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+Once the collector service is running and the GitHub App is installed on your GHE organization(s), complete the integration setup as instructed in the New Relic UI:
+
+1. The corresponding GHE organizations will appear in the New Relic UI.
+2. Click **First time sync** to start the initial data synchronization.


Suggested change

2. Click **First time sync** to start the initial data synchronization.

2. To start the initial data synchronization, click **First time sync**.

vpayyapilly · 2025-11-05T05:13:53Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+1. The corresponding GHE organizations will appear in the New Relic UI.
+2. Click **First time sync** to start the initial data synchronization.
+3. *(Optional)* Click **On-demand sync** to manually sync the data.


How is this a step in the setup?

vpayyapilly · 2025-11-05T05:14:55Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+
+On the **GitHub Enterprise integration** screen:
+
+* Click **Go to Teams** to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).


Suggested change

* Click **Go to Teams** to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).

* To view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams), click **Go to Teams**.

vpayyapilly · 2025-11-05T05:15:23Z

...docs/service-architecture-intelligence/github-integrations/github-enterprise-integration.mdx

+On the **GitHub Enterprise integration** screen:
+
+* Click **Go to Teams** to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).
+* Click **Go to Repositories** to view the imported repositories information on [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs).


Suggested change

* Click **Go to Repositories** to view the imported repositories information on [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs).

* To view the imported repositories information on [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs), click **Go to Repositories**.

vpayyapilly

Fix and merge

cbehera-newrelic added 3 commits October 15, 2025 20:01

wip

52f149b

wip

a6a4ea2

wip

7dca6ef

cbehera-newrelic self-assigned this Oct 17, 2025

cbehera-newrelic added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Oct 17, 2025

vpayyapilly reviewed Oct 21, 2025

View reviewed changes

cbehera-newrelic added 4 commits October 23, 2025 09:26

wip

fd35b6f

wip

c4f0f41

Merge branch 'develop' into GHE-integration

0ba5a33

fixing merge conflicts

88febe5

cbehera-newrelic added 4 commits October 28, 2025 19:20

removed image

903de75

deleted unpaired translation

c2a8f77

Fixed review comments

79b23fe

fixing merge conflicts

be92db9

All review comments are addressed

c2b96f9

Updates to styes

46f78be

review comments are addressed

168cd73

minor enhancements

b2f48c4

vpayyapilly reviewed Nov 5, 2025

View reviewed changes

vpayyapilly approved these changes Nov 5, 2025

View reviewed changes


		Prerequisites

		* Login to your GitHub Enterprise account you plan to integrate with New Relic.

	* Login to your GitHub Enterprise account you plan to integrate with New Relic.
	* Login to the GitHub Enterprise account you plan to integrate with New Relic.

		* Docker environment to run the collector service within your GHE network.


		Architecture overview


		1. Create and configure a GitHub app: In your GHE instance, navigate to Settings → Developer Settings → GitHub Apps → New GitHub App.

		1. Configure Permissions: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided.


		Option B: Direct Docker image run

		You can download the Docker image directly from our Docker App registry and run it using your organization's preferred CI/CD pipeline or deployment method.


		5. On the GitHub Enterprise integration screen:

		- Click Go to Teams to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).

	Security best practice: Only enable the minimum permissions required for your integration needs. This reduces security exposure and follows the principle of least privilege access.
	Security best practice: To reduce security exposure, follow the principle of least privilege access and only enable the minimum permissions required for your integration needs.


		### Generate and convert keys

		1. Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.

	1. Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.
	1. Upon creation, the app generates a unique App ID and a Private Key file (.pem format). Save these securely as you need them for the collector service configuration.

	4. Click Install App in the left sidebar.
	4. In the left sidebar, click Install App.

	2. Click First time sync to start the initial data synchronization.
	2. To start the initial data synchronization, click First time sync.


		On the GitHub Enterprise integration screen:

		* Click Go to Teams to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).

	* Click Go to Teams to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams).
	* To view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams), click Go to Teams.

	* Click Go to Repositories to view the imported repositories information on [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs).
	* To view the imported repositories information on [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs), click Go to Repositories.

Ghe integration #21929

Are you sure you want to change the base?

Ghe integration #21929

Uh oh!

Conversation

cbehera-newrelic commented Oct 16, 2025

Uh oh!

github-actions bot commented Oct 16, 2025

Uh oh!

cbehera-newrelic commented Oct 16, 2025

Uh oh!

cbehera-newrelic commented Oct 16, 2025

Uh oh!

github-actions bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Netlify Preview Building!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vpayyapilly left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 28, 2025

Uh oh!

cbehera-newrelic commented Oct 30, 2025

Uh oh!

cbehera-newrelic commented Oct 30, 2025

Uh oh!

cbehera-newrelic commented Oct 30, 2025

Uh oh!

cbehera-newrelic commented Oct 30, 2025

Uh oh!

cbehera-newrelic commented Nov 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vpayyapilly left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Oct 16, 2025 •

edited

Loading